Create an agent billing plan

curl --request POST \
  --url https://api.hyperline.co/v1/ai/billing/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support agent plan",
  "mode": "wallet",
  "rate_card_id": "airc_example",
  "overage_mode": "metered",
  "markup_percent": "20",
  "overage_markup_percent": "10",
  "overage_rate_card_id": "airc_overage",
  "windows": [
    {
      "key": "daily",
      "duration_minutes": 1440,
      "included_units": "10000"
    }
  ],
  "per_seat_credits": "10000",
  "grant_rollover_enabled": true,
  "settlement_interval_minutes": 60,
  "settlement_schedule": "calendar_month"
}
'

import requests

url = "https://api.hyperline.co/v1/ai/billing/plans"

payload = {
    "name": "Support agent plan",
    "mode": "wallet",
    "rate_card_id": "airc_example",
    "overage_mode": "metered",
    "markup_percent": "20",
    "overage_markup_percent": "10",
    "overage_rate_card_id": "airc_overage",
    "windows": [
        {
            "key": "daily",
            "duration_minutes": 1440,
            "included_units": "10000"
        }
    ],
    "per_seat_credits": "10000",
    "grant_rollover_enabled": True,
    "settlement_interval_minutes": 60,
    "settlement_schedule": "calendar_month"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Support agent plan',
    mode: 'wallet',
    rate_card_id: 'airc_example',
    overage_mode: 'metered',
    markup_percent: '20',
    overage_markup_percent: '10',
    overage_rate_card_id: 'airc_overage',
    windows: [{key: 'daily', duration_minutes: 1440, included_units: '10000'}],
    per_seat_credits: '10000',
    grant_rollover_enabled: true,
    settlement_interval_minutes: 60,
    settlement_schedule: 'calendar_month'
  })
};

fetch('https://api.hyperline.co/v1/ai/billing/plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/ai/billing/plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Support agent plan',
    'mode' => 'wallet',
    'rate_card_id' => 'airc_example',
    'overage_mode' => 'metered',
    'markup_percent' => '20',
    'overage_markup_percent' => '10',
    'overage_rate_card_id' => 'airc_overage',
    'windows' => [
        [
                'key' => 'daily',
                'duration_minutes' => 1440,
                'included_units' => '10000'
        ]
    ],
    'per_seat_credits' => '10000',
    'grant_rollover_enabled' => true,
    'settlement_interval_minutes' => 60,
    'settlement_schedule' => 'calendar_month'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/ai/billing/plans"

	payload := strings.NewReader("{\n  \"name\": \"Support agent plan\",\n  \"mode\": \"wallet\",\n  \"rate_card_id\": \"airc_example\",\n  \"overage_mode\": \"metered\",\n  \"markup_percent\": \"20\",\n  \"overage_markup_percent\": \"10\",\n  \"overage_rate_card_id\": \"airc_overage\",\n  \"windows\": [\n    {\n      \"key\": \"daily\",\n      \"duration_minutes\": 1440,\n      \"included_units\": \"10000\"\n    }\n  ],\n  \"per_seat_credits\": \"10000\",\n  \"grant_rollover_enabled\": true,\n  \"settlement_interval_minutes\": 60,\n  \"settlement_schedule\": \"calendar_month\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/ai/billing/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support agent plan\",\n  \"mode\": \"wallet\",\n  \"rate_card_id\": \"airc_example\",\n  \"overage_mode\": \"metered\",\n  \"markup_percent\": \"20\",\n  \"overage_markup_percent\": \"10\",\n  \"overage_rate_card_id\": \"airc_overage\",\n  \"windows\": [\n    {\n      \"key\": \"daily\",\n      \"duration_minutes\": 1440,\n      \"included_units\": \"10000\"\n    }\n  ],\n  \"per_seat_credits\": \"10000\",\n  \"grant_rollover_enabled\": true,\n  \"settlement_interval_minutes\": 60,\n  \"settlement_schedule\": \"calendar_month\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/ai/billing/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Support agent plan\",\n  \"mode\": \"wallet\",\n  \"rate_card_id\": \"airc_example\",\n  \"overage_mode\": \"metered\",\n  \"markup_percent\": \"20\",\n  \"overage_markup_percent\": \"10\",\n  \"overage_rate_card_id\": \"airc_overage\",\n  \"windows\": [\n    {\n      \"key\": \"daily\",\n      \"duration_minutes\": 1440,\n      \"included_units\": \"10000\"\n    }\n  ],\n  \"per_seat_credits\": \"10000\",\n  \"grant_rollover_enabled\": true,\n  \"settlement_interval_minutes\": 60,\n  \"settlement_schedule\": \"calendar_month\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "d18603dd-7285-4bf5-a45e-88d7de8f37c9",
  "name": "Support agent plan",
  "mode": "wallet",
  "rate_card": null,
  "windows": [
    {
      "key": "daily",
      "duration_minutes": 1440,
      "included_units": "10000"
    }
  ],
  "markup_percent": "20",
  "overage_mode": "metered",
  "overage_markup_percent": "10",
  "overage_rate_card_id": "airc_overage",
  "settlement_interval_minutes": 60,
  "settlement_schedule": "calendar_month",
  "per_seat_credits": "10000",
  "grant_rollover_enabled": true,
  "billing_item_ids": [
    "prd_agent_plan"
  ],
  "price_configuration_ids": [
    "pcfg_agent_plan"
  ],
  "using_policy_count": 1,
  "is_default": false
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

POST

billing

plans

Create an agent billing plan

curl --request POST \
  --url https://api.hyperline.co/v1/ai/billing/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support agent plan",
  "mode": "wallet",
  "rate_card_id": "airc_example",
  "overage_mode": "metered",
  "markup_percent": "20",
  "overage_markup_percent": "10",
  "overage_rate_card_id": "airc_overage",
  "windows": [
    {
      "key": "daily",
      "duration_minutes": 1440,
      "included_units": "10000"
    }
  ],
  "per_seat_credits": "10000",
  "grant_rollover_enabled": true,
  "settlement_interval_minutes": 60,
  "settlement_schedule": "calendar_month"
}
'

import requests

url = "https://api.hyperline.co/v1/ai/billing/plans"

payload = {
    "name": "Support agent plan",
    "mode": "wallet",
    "rate_card_id": "airc_example",
    "overage_mode": "metered",
    "markup_percent": "20",
    "overage_markup_percent": "10",
    "overage_rate_card_id": "airc_overage",
    "windows": [
        {
            "key": "daily",
            "duration_minutes": 1440,
            "included_units": "10000"
        }
    ],
    "per_seat_credits": "10000",
    "grant_rollover_enabled": True,
    "settlement_interval_minutes": 60,
    "settlement_schedule": "calendar_month"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Support agent plan',
    mode: 'wallet',
    rate_card_id: 'airc_example',
    overage_mode: 'metered',
    markup_percent: '20',
    overage_markup_percent: '10',
    overage_rate_card_id: 'airc_overage',
    windows: [{key: 'daily', duration_minutes: 1440, included_units: '10000'}],
    per_seat_credits: '10000',
    grant_rollover_enabled: true,
    settlement_interval_minutes: 60,
    settlement_schedule: 'calendar_month'
  })
};

fetch('https://api.hyperline.co/v1/ai/billing/plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/ai/billing/plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Support agent plan',
    'mode' => 'wallet',
    'rate_card_id' => 'airc_example',
    'overage_mode' => 'metered',
    'markup_percent' => '20',
    'overage_markup_percent' => '10',
    'overage_rate_card_id' => 'airc_overage',
    'windows' => [
        [
                'key' => 'daily',
                'duration_minutes' => 1440,
                'included_units' => '10000'
        ]
    ],
    'per_seat_credits' => '10000',
    'grant_rollover_enabled' => true,
    'settlement_interval_minutes' => 60,
    'settlement_schedule' => 'calendar_month'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/ai/billing/plans"

	payload := strings.NewReader("{\n  \"name\": \"Support agent plan\",\n  \"mode\": \"wallet\",\n  \"rate_card_id\": \"airc_example\",\n  \"overage_mode\": \"metered\",\n  \"markup_percent\": \"20\",\n  \"overage_markup_percent\": \"10\",\n  \"overage_rate_card_id\": \"airc_overage\",\n  \"windows\": [\n    {\n      \"key\": \"daily\",\n      \"duration_minutes\": 1440,\n      \"included_units\": \"10000\"\n    }\n  ],\n  \"per_seat_credits\": \"10000\",\n  \"grant_rollover_enabled\": true,\n  \"settlement_interval_minutes\": 60,\n  \"settlement_schedule\": \"calendar_month\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/ai/billing/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support agent plan\",\n  \"mode\": \"wallet\",\n  \"rate_card_id\": \"airc_example\",\n  \"overage_mode\": \"metered\",\n  \"markup_percent\": \"20\",\n  \"overage_markup_percent\": \"10\",\n  \"overage_rate_card_id\": \"airc_overage\",\n  \"windows\": [\n    {\n      \"key\": \"daily\",\n      \"duration_minutes\": 1440,\n      \"included_units\": \"10000\"\n    }\n  ],\n  \"per_seat_credits\": \"10000\",\n  \"grant_rollover_enabled\": true,\n  \"settlement_interval_minutes\": 60,\n  \"settlement_schedule\": \"calendar_month\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/ai/billing/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Support agent plan\",\n  \"mode\": \"wallet\",\n  \"rate_card_id\": \"airc_example\",\n  \"overage_mode\": \"metered\",\n  \"markup_percent\": \"20\",\n  \"overage_markup_percent\": \"10\",\n  \"overage_rate_card_id\": \"airc_overage\",\n  \"windows\": [\n    {\n      \"key\": \"daily\",\n      \"duration_minutes\": 1440,\n      \"included_units\": \"10000\"\n    }\n  ],\n  \"per_seat_credits\": \"10000\",\n  \"grant_rollover_enabled\": true,\n  \"settlement_interval_minutes\": 60,\n  \"settlement_schedule\": \"calendar_month\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "d18603dd-7285-4bf5-a45e-88d7de8f37c9",
  "name": "Support agent plan",
  "mode": "wallet",
  "rate_card": null,
  "windows": [
    {
      "key": "daily",
      "duration_minutes": 1440,
      "included_units": "10000"
    }
  ],
  "markup_percent": "20",
  "overage_mode": "metered",
  "overage_markup_percent": "10",
  "overage_rate_card_id": "airc_overage",
  "settlement_interval_minutes": 60,
  "settlement_schedule": "calendar_month",
  "per_seat_credits": "10000",
  "grant_rollover_enabled": true,
  "billing_item_ids": [
    "prd_agent_plan"
  ],
  "price_configuration_ids": [
    "pcfg_agent_plan"
  ],
  "using_policy_count": 1,
  "is_default": false
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create plan payload

name

string

required

Human-readable resource name.

Required string length: 1 - 120

Example:

"Support agent plan"

mode

enum<string>

required

Billing mode.

wallet: Charges a monetary wallet.
credits: Consumes a credit balance.
windows: Meters weighted units against rolling allowances.

Available options:

wallet,

credits,

windows

Example:

"wallet"

rate_card_id

string | null

Rate card reference. On policy writes, omission preserves the current reference and null detaches it; on plan replacement omission clears it.

Minimum string length: 1

Example:

"airc_example"

overage_mode

enum<string> | null

Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.

refuse: Rejects the call that crosses the boundary without deducting usage.
metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.

Available options:

refuse,

metered

Example:

"metered"

markup_percent

string | null

Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.

Maximum string length: 40

Pattern: ^\d+(\.\d+)?$

Example:

"20"

overage_markup_percent

string | null

Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id.

Maximum string length: 40

Pattern: ^\d+(\.\d+)?$

Example:

"10"

overage_rate_card_id

string | null

Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup.

Minimum string length: 1

Example:

"airc_overage"

windows

object[]

Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array.

Required array length: 1 - 8 elements

Show child attributes

Example:

[
  {
    "key": "daily",
    "duration_minutes": 1440,
    "included_units": "10000"
  }
]

per_seat_credits

string | null

Credits granted per seat per billing period. Null grants no credits.

Maximum string length: 40

Pattern: ^\d+(\.\d+)?$

Example:

"10000"

grant_rollover_enabled

boolean

Whether granted credits survive renewal. Purchased credits always roll over.

Example:

true

settlement_interval_minutes

integer | null

Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.

Required range: 60 <= x <= 44640

Example:

60

settlement_schedule

enum<string> | null

Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes.

calendar_month: Settles at the end of each UTC calendar month.

Available options:

calendar_month

Example:

"calendar_month"

Response

string

required

Unique Hyperline identifier for this resource.

Example:

"d18603dd-7285-4bf5-a45e-88d7de8f37c9"

name

string

required

Human-readable resource name.

Example:

"Support agent plan"

mode

enum<string>

required

Billing mode.

wallet: Charges a monetary wallet.
credits: Consumes a credit balance.
windows: Meters weighted units against rolling allowances.

Available options:

wallet,

credits,

windows

Example:

"wallet"

rate_card

object | null

required

Public rate card used by this plan, or null when the plan supplies none.

Show child attributes

Example:

null

windows

object[]

required

Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array.

Show child attributes

Example:

[
  {
    "key": "daily",
    "duration_minutes": 1440,
    "included_units": "10000"
  }
]

markup_percent

string | null

required

Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i

Example:

"20"

overage_mode

enum<string>

required

Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.

refuse: Rejects the call that crosses the boundary without deducting usage.
metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.

Available options:

refuse,

metered

Example:

"metered"

overage_markup_percent

string | null

required

Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i

Example:

"10"

overage_rate_card_id

string | null

required

Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup.

Example:

"airc_overage"

settlement_interval_minutes

number | null

required

Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.

Example:

60

settlement_schedule

enum<string> | null

required

Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes.

calendar_month: Settles at the end of each UTC calendar month.

Available options:

calendar_month

Example:

"calendar_month"

per_seat_credits

string | null

required

Credits granted per seat per billing period. Null grants no credits.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i

Example:

"10000"

grant_rollover_enabled

boolean

required

Whether granted credits survive renewal. Purchased credits always roll over.

Example:

true

billing_item_ids

string[]

required

Public product identifiers for this plan's invoice charges, in creation order. Read-only; amounts are defined by the corresponding price configurations.

Example:

["prd_agent_plan"]

price_configuration_ids

string[]

required

Public price configuration identifiers corresponding to billing_item_ids. Read-only.

Example:

["pcfg_agent_plan"]

using_policy_count

number

required

Number of customer policy scopes referencing this resource.

Example:

1

is_default

boolean

required

Whether this is the default plan or shared customer scope.

Example:

false

⌘I